From dd1f0c46b3492e2871b56c1057b2a6c9470f0a00 Mon Sep 17 00:00:00 2001 From: =?utf8?q?Javier=20Jard=C3=B3n?= Date: Tue, 6 Jul 2010 22:06:34 +0200 Subject: [PATCH] [docs] GtkCalendar: Move documentation to inline comments MIME-Version: 1.0 Content-Type: text/plain; charset=utf8 Content-Transfer-Encoding: 8bit Fixes https://bugzilla.gnome.org/show_bug.cgi?id=617389 Signed-off-by: Javier Jardón --- docs/reference/gtk/tmpl/.gitignore | 1 + docs/reference/gtk/tmpl/gtkcalendar.sgml | 315 ----------------------- gtk/gtkcalendar.c | 72 ++++++ 3 files changed, 73 insertions(+), 315 deletions(-) delete mode 100644 docs/reference/gtk/tmpl/gtkcalendar.sgml diff --git a/docs/reference/gtk/tmpl/.gitignore b/docs/reference/gtk/tmpl/.gitignore index 996aa553b9..c198043408 100644 --- a/docs/reference/gtk/tmpl/.gitignore +++ b/docs/reference/gtk/tmpl/.gitignore @@ -2,6 +2,7 @@ gtkbbox.sgml gtkbox.sgml gtkbuilder.sgml gtkbutton.sgml +gtkcalendar.sgml gtkhbox.sgml gtkiconview.sgml gtkmessagedialog.sgml diff --git a/docs/reference/gtk/tmpl/gtkcalendar.sgml b/docs/reference/gtk/tmpl/gtkcalendar.sgml deleted file mode 100644 index 4c117a6149..0000000000 --- a/docs/reference/gtk/tmpl/gtkcalendar.sgml +++ /dev/null @@ -1,315 +0,0 @@ - -GtkCalendar - - -Displays a calendar and allows the user to select a date - - - -#GtkCalendar is a widget that displays a calendar, one month at a time. -It can be created with gtk_calendar_new(). - - -The month and year currently displayed can be altered with -gtk_calendar_select_month(). The exact day can be selected from the displayed -month using gtk_calendar_select_day(). - - -To place a visual marker on a particular day, use gtk_calendar_mark_day() -and to remove the marker, gtk_calendar_unmark_day(). -Alternative, all marks can be cleared with gtk_calendar_clear_marks(). - - -The way in which the calendar itself is displayed can be altered using -gtk_calendar_set_display_options(). - - -The selected date can be retrieved from a #GtkCalendar using -gtk_calendar_get_date(). - - - - - - - - - - - - - - - -num_marked_dates is an integer containing the -number of days that have a mark over them. - - -marked_date is an array containing the day numbers -that currently have a mark over them. - - -month, year, and -selected_day contain the currently visible month, -year, and selected day respectively. - - -All of these fields should be considered read only, and everything in this -struct should only be modified using the functions provided below. - - - -Note that month is zero-based (i.e it allowed values -are 0-11) while selected_day is one-based -(i.e. allowed values are 1-31). - - - - - - -Emitted when the user selects a day. - - -@calendar: the object which received the signal. - - - - - - -@calendar: the object which received the signal. - - - -Emitted when the user clicks a button to change the selected month on a -calendar. - - -@calendar: the object which received the signal. - - - - - - -@calendar: the object which received the signal. - - - - - - -@calendar: the object which received the signal. - - - - - - -@calendar: the object which received the signal. - - - - - - -@calendar: the object which received the signal. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -@calendar: -@year: -@month: -@day: -@user_data: -@Returns: - - - - - - -@GTK_CALENDAR_SHOW_HEADING: -@GTK_CALENDAR_SHOW_DAY_NAMES: -@GTK_CALENDAR_NO_MONTH_CHANGE: -@GTK_CALENDAR_SHOW_WEEK_NUMBERS: -@GTK_CALENDAR_WEEK_START_MONDAY: -@GTK_CALENDAR_SHOW_DETAILS: - - - - - -@void: -@Returns: - - - - - - -@calendar: -@month: -@year: - - - - - - -@calendar: -@day: - - - - - - -@calendar: -@day: - - - - - - -@calendar: -@day: - - - - - - -@calendar: - - - - - - - -@calendar: -@Returns: - - - - - - - -@calendar: -@flags: - - - - - - -@calendar: -@year: -@month: -@day: - - - - - - - -@calendar: -@func: -@data: -@destroy: - - - - - - - -@calendar: -@Returns: - - - - - - - -@calendar: -@chars: - - - - - - - -@calendar: -@Returns: - - - - - - - -@calendar: -@rows: - - diff --git a/gtk/gtkcalendar.c b/gtk/gtkcalendar.c index 0b456e6e84..bd8cfdc502 100644 --- a/gtk/gtkcalendar.c +++ b/gtk/gtkcalendar.c @@ -29,6 +29,29 @@ * GTK+ at ftp://ftp.gtk.org/pub/gtk/. */ +/** + * SECTION:gtkcalendar + * @Short_description: Displays a calendar and allows the user to select a date + * @Title: GtkCalendar + * + * #GtkCalendar is a widget that displays a calendar, one month at a time. It + * can be created with gtk_calendar_new(). + * + * The month and year currently displayed can be altered with + * gtk_calendar_select_month(). The exact day can be selected from the displayed + * month using gtk_calendar_select_day(). + * + * To place a visual marker on a particular day, use gtk_calendar_mark_day() and + * to remove the marker, gtk_calendar_unmark_day(). Alternative, all marks can + * be cleared with gtk_calendar_clear_marks(). + * + * The way in which the calendar itself is displayed can be altered using + * gtk_calendar_set_display_options(). + * + * The selected date can be retrieved from a #GtkCalendar using + * gtk_calendar_get_date(). + */ + #include "config.h" #ifdef HAVE_SYS_TIME_H @@ -579,6 +602,13 @@ gtk_calendar_class_init (GtkCalendarClass *class) TRUE, GTK_PARAM_READWRITE)); + /** + * GtkCalendar::month-changed: + * @calendar: the object which received the signal. + * + * Emitted when the user clicks a button to change the selected month on a + * calendar. + */ gtk_calendar_signals[MONTH_CHANGED_SIGNAL] = g_signal_new (I_("month-changed"), G_OBJECT_CLASS_TYPE (gobject_class), @@ -587,6 +617,13 @@ gtk_calendar_class_init (GtkCalendarClass *class) NULL, NULL, _gtk_marshal_VOID__VOID, G_TYPE_NONE, 0); + + /** + * GtkCalendar::day-selected: + * @calendar: the object which received the signal. + * + * Emitted when the user selects a day. + */ gtk_calendar_signals[DAY_SELECTED_SIGNAL] = g_signal_new (I_("day-selected"), G_OBJECT_CLASS_TYPE (gobject_class), @@ -595,6 +632,13 @@ gtk_calendar_class_init (GtkCalendarClass *class) NULL, NULL, _gtk_marshal_VOID__VOID, G_TYPE_NONE, 0); + + /** + * GtkCalendar::day-selected-double-click: + * @calendar: the object which received the signal. + * + * Emitted when the user double-clicks a day. + */ gtk_calendar_signals[DAY_SELECTED_DOUBLE_CLICK_SIGNAL] = g_signal_new (I_("day-selected-double-click"), G_OBJECT_CLASS_TYPE (gobject_class), @@ -603,6 +647,13 @@ gtk_calendar_class_init (GtkCalendarClass *class) NULL, NULL, _gtk_marshal_VOID__VOID, G_TYPE_NONE, 0); + + /** + * GtkCalendar::prev-month: + * @calendar: the object which received the signal. + * + * Emitted when the user switched to the previous month. + */ gtk_calendar_signals[PREV_MONTH_SIGNAL] = g_signal_new (I_("prev-month"), G_OBJECT_CLASS_TYPE (gobject_class), @@ -611,6 +662,13 @@ gtk_calendar_class_init (GtkCalendarClass *class) NULL, NULL, _gtk_marshal_VOID__VOID, G_TYPE_NONE, 0); + + /** + * GtkCalendar::next-month: + * @calendar: the object which received the signal. + * + * Emitted when the user switched to the next month. + */ gtk_calendar_signals[NEXT_MONTH_SIGNAL] = g_signal_new (I_("next-month"), G_OBJECT_CLASS_TYPE (gobject_class), @@ -619,6 +677,13 @@ gtk_calendar_class_init (GtkCalendarClass *class) NULL, NULL, _gtk_marshal_VOID__VOID, G_TYPE_NONE, 0); + + /** + * GtkCalendar::prev-year: + * @calendar: the object which received the signal. + * + * Emitted when user switched to the previous year. + */ gtk_calendar_signals[PREV_YEAR_SIGNAL] = g_signal_new (I_("prev-year"), G_OBJECT_CLASS_TYPE (gobject_class), @@ -627,6 +692,13 @@ gtk_calendar_class_init (GtkCalendarClass *class) NULL, NULL, _gtk_marshal_VOID__VOID, G_TYPE_NONE, 0); + + /** + * GtkCalendar::next-year: + * @calendar: the object which received the signal. + * + * Emitted when user switched to the next year. + */ gtk_calendar_signals[NEXT_YEAR_SIGNAL] = g_signal_new (I_("next-year"), G_OBJECT_CLASS_TYPE (gobject_class), -- 2.30.2